Carbon


IsWindowCollapsed

Header: MacWindows.h Carbon status: Supported

Determines whether a window is currently collapsed.

Boolean IsWindowCollapsed (
    WindowRef window
);
window

A pointer to the window to be examined.

function result

If true, the window is collapsed. If false, the window is expanded.

DISCUSSION

Only window definition functions that return the feature bit kWindowCanCollapse in response to a kWindowGetFeatures message support this function; see GetWindowFeatures. Your window definition function should call IsWindowCollapsed to determine whether or not a window is collapsed, so you can modify its structure and content regions as appropriate. Typically, a window’s content region is empty in a collapsed state.

VERSION NOTES

This function is available with Appearance Manager 1.0 and later.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when CarbonLib 1.0 or later is installed. Exported by CarbonLib 1.0 and later and by CarbonLib 1.0 and later.


© 2000 Apple Computer, Inc. — (Last Updated 4/14/2000)